Xbasic

VARIABLES_ENUM Function

Syntax

String as C = VARIABLES_ENUM(P variables[,C variable_enum_flags])

Arguments

variablesPointer

A pointer to a variable frame.

variable_enum_flagsCharacter

Character

Description

Returns CR-LF separated variable list.

Discussion

VARIABLES_ENUM() returns a CR-LF delimited string of variable names in the variable frame referenced by Pointer.

Example

The following commands display a message box with all global variables.

'get a pointer to the global variable frame
g = global_variables()
string = variables_enum(g)
ui_msg_box("Global Variables", string)

The following commands list all of the local variables in a script.

v = local_variables()
string = variables_enum(v)
ui_msg_box("Local Variables", string)

See Also